/**
 * Copyright 2009-2018 the original author or authors.
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ibatis.executor;

import java.sql.BatchUpdateException;
import java.util.List;

/**
 * This exception is thrown if a <code>java.sql.BatchUpdateException</code> is caught
 * during the execution of any nested batch.  The exception contains the
 * java.sql.BatchUpdateException that is the root cause, as well as
 * the results from any prior nested batch that executed successfully.  
 *
 * @author Jeff Butler
 */
public class BatchExecutorException extends ExecutorException {

    private static final long serialVersionUID = 154049229650533990L;
    private final List<BatchResult> successfulBatchResults;
    private final BatchUpdateException batchUpdateException;
    private final BatchResult batchResult;

    public BatchExecutorException(String message,
                                  BatchUpdateException cause,
                                  List<BatchResult> successfulBatchResults,
                                  BatchResult batchResult) {
        super(message + " Cause: " + cause, cause);
        this.batchUpdateException = cause;
        this.successfulBatchResults = successfulBatchResults;
        this.batchResult = batchResult;
    }

    /**
     * Returns the BatchUpdateException that caused the nested executor
     * to fail.  That exception contains an array of row counts
     * that can be used to determine exactly which statement of the
     * executor caused the failure (or failures).
     *
     * @return the root BatchUpdateException
     */
    public BatchUpdateException getBatchUpdateException() {
        return batchUpdateException;
    }

    /**
     * Returns a list of BatchResult objects.  There will be one entry
     * in the list for each successful sub-executor executed before the failing
     * executor.
     *
     * @return the previously successful executor results (may be an empty list
     *         if no executor has executed successfully)
     */
    public List<BatchResult> getSuccessfulBatchResults() {
        return successfulBatchResults;
    }

    /**
     * Returns the SQL statement that caused the failure
     * (not the parameterArray)
     *
     * @return the failing SQL string
     */
    public String getFailingSqlStatement() {
        return batchResult.getSql();
    }

    /**
     * Returns the statement id of the statement that caused the failure
     *
     * @return the statement id
     */
    public String getFailingStatementId() {
        return batchResult.getMappedStatement().getId();
    }
}
